/*
 * Copyright 2012-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.autoconfigure.domain;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.Import;
import org.springframework.core.annotation.AliasFor;

/**
 * 配置自动配置在扫描实体类时使用的基础包。
 * <p>
 * 使用 {@code @EntityScan} 将导致自动配置：
 * <ul>
 * <li>为 JPA 实体设置
 * {@link org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean#setPackagesToScan(String...)
 * 扫描的包}。</li>
 * <li>设置用于 Spring Data
 * {@link org.springframework.data.mongodb.core.mapping.MongoMappingContext MongoDB}、
 * {@link org.springframework.data.neo4j.core.mapping.Neo4jMappingContext Neo4j}、
 * {@link org.springframework.data.cassandra.core.mapping.CassandraMappingContext
 * Cassandra} 和
 * {@link org.springframework.data.couchbase.core.mapping.CouchbaseMappingContext
 * Couchbase} 映射上下文的
 * {@link org.springframework.data.mapping.context.AbstractMappingContext#setInitialEntitySet(java.util.Set)
 * 初始实体集}。</li>
 * </ul>
 * <p>
 * 可以指定 {@link #basePackageClasses()}、{@link #basePackages()} 或其别名
 * {@link #value()} 中的一个来定义要扫描的特定包。如果未定义特定包，则将从带有此注解的类的包开始扫描。
 *
 * @author Phillip Webb
 * @since 1.4.0
 * @see EntityScanPackages
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(EntityScanPackages.Registrar.class)
public @interface EntityScan {

	/**
	 * {@link #basePackages()} 属性的别名。允许更简洁的注解声明，例如：
	 * {@code @EntityScan("org.my.pkg")} 而不是
	 * {@code @EntityScan(basePackages="org.my.pkg")}。
	 * @return 要扫描的基础包
	 */
	@AliasFor("basePackages")
	String[] value() default {};

	/**
	 * 要扫描实体的基础包。{@link #value()} 是此属性的别名（并且与此属性互斥）。
	 * <p>
	 * 使用 {@link #basePackageClasses()} 作为基于 String 的包名的类型安全替代方案。
	 * @return 要扫描的基础包
	 */
	@AliasFor("value")
	String[] basePackages() default {};

	/**
	 * {@link #basePackages()} 的类型安全替代方案，用于指定要扫描实体的包。
	 * 将扫描指定的每个类的包。
	 * <p>
	 * 考虑在每个包中创建一个特殊的无操作标记类或接口，其唯一目的就是被此属性引用。
	 * @return 来自要扫描的基础包的类
	 */
	Class<?>[] basePackageClasses() default {};

}
